MFG PIM System API - Implementation Template

(0 reviews)

Data mappings

This document provides information generated from the DataWeave scripts included in the project, such as function definitions, variable definitions, and data mapping tables.

ModuleDescription
products-getbyid-payloadProducts select Mapping for PIM System
products-get-payloadProducts select Mapping for PIM System
products-patchbyid-payloadProducts Upsert Mapping for PIM System
products-upsert-pricebooks-payloadPriceBookEntry Upsert Mapping for PIM System
products-upsert-productcategorycatalog-payloadProduct Category and Product Catalog - Upsert Mapping for PIM System
products-upsert-products-payloadProducts Upsert Mapping for PIM System

products-getbyid-payload

Products select Mapping for PIM System

Source: ./src/main/resources/dwl/products-getbyid-payload.dwl

Mapping Tables

Maps CIM Product to JSON which is used by stored procedure - sp_Products_Upsert

JSON used by the stored procedureCIMDescription
allowCustomerReturnallowCustomerReturnflag to allow customer to return a Product
allowPartialRefundallowPartialRefundflag to allow partial refund for a Product
brandbrandbrand grade of a Product
brandGradebrandGradebrand grade of a Product
canUseQuantitySchedulecanUseQuantityScheduleflag for quantity schedule
canUseRevenueSchedulecanUseRevenueScheduleflag for revenue schedule
descriptiondescriptiondescription of the Product
displayUrldisplayUrldisplay URL of the Product
disposalTypedisposalTypedisposal type of the Product
externalSourceRecordexternalSourceRecordexternal source record of the Product
glAccountCodeglAccountCodeGL Account Code of the Product
ididunique Id of the Product
isAutoProvisionableisAutoProvisionableflag for auto provisioning
isBackOrderedisBackOrderedflag for back ordered Product
isCouponRedemptionAllowedisCouponRedemptionAllowedflag to allow redemption of coupon
isCustomerDiscountAllowedisCustomerDiscountAllowedflag to allow customer discount on the Product
isDynamicBundleisDynamicBundleflag to highlight if a Product is part of a dynamic bundle
isFoodstampPaymentAllowedisFoodstampPaymentAllowedflag to allow food stamp payment
isInstallableisInstallableflag to install a Product
isIntellectualPropertyProtectedisIntellectualPropertyProtectedflag to protect the Product as intellectual property
isManualPriceEntryRequiredisManualPriceEntryRequiredflag to enter the price of Product manually
isMultipleCouponsAllowedisMultipleCouponsAllowedflag to allow multiple coupons on the Product
isPartnerDiscountAllowedisPartnerDiscountAllowedflag to allow partner discounts
isPreOrderableisPreOrderableflag to preorder the Product
isQualityVerificationRequiredisQualityVerificationRequiredflag to mandate verification of quality of the Product
isQuantityEntryRequiredisQuantityEntryRequiredflag to mandate entry of quantity
isRainCheckAllowedisRainCheckAllowedflag to allow rain check
isReturnableisReturnableflag to allow returning of Product
isSellableisSellableflag allow a Product to be sold
isSellableIndependentlyisSellableIndependentlyflag to allow a Product to be sold independently
isSellableWithoutPriceisSellableWithoutPriceflag to allow a Product to be sold independently
isSerializedisSerializedflag to serialize a Product
isWeightEntryRequiredisWeightEntryRequiredflag to enter weight of the Product
isWorkerDiscountAllowedisWorkerDiscountAllowedflag to allow discount for workers
longDescriptionlongDescriptionlong description of the Product
lotIdentitylotIdentitylot to identify the Product
manufacturerNamemanufacturerNamemanufacturer name of the Product
masterProductmasterProductmaster Product of the Product
maximumOrderQuantityCountmaximumOrderQuantityCountmax. quantity that can be ordered of that Product
minimumAdvertisementAmountminimumAdvertisementAmountmin. amount of advertisement of the Product
minimumAdvertisementAmountStartDateminimumAdvertisementAmountStartDatemin. amount to start advertisement of the Product
minimumOrderQuantityCountminimumOrderQuantityCountmin. amount of advertisement of the Product
modelNumbermodelNumbermodel number of the Product
modelYearmodelYearmodel year of the Product
mSRPAmountmSRPAmountMSRP amount of the Product
namenamename of the Product
priceChargeTypepriceChargeTypeprice change type of the Product
primaryProductCategoryprimaryProductCategoryprimary category of the Product
primarySalesChannelprimarySalesChannelprimary sales channel for the Product
productSKUproductSKUSKU of the Product
productStatusproductStatusstatus of the Product
quantityInstallmentCountquantityInstallmentCountquantity installment count of the Product
quantityInstallmentPeriodquantityInstallmentPeriodquantity installment period of the Product
quantityScheduleTypequantityScheduleTypequantity schedule type of the Product
requiredDepositAmountrequiredDepositAmountrequested deposit amount for the Product
requiredDepositPercentagerequiredDepositPercentagerequested deposit percentage for the Product
requiresInvididualUnitPricingrequiresInvididualUnitPricingflag to highlight that the Product requires individual unit pricing
revenueInstallmentCountrevenueInstallmentCountrevenue installment count of the Product
revenueInstallmentPeriodrevenueInstallmentPeriodrevenue installment period of the Product
revenueScheduleTyperevenueScheduleTyperevenue schedule type of the Product
rewardProgramPointsCountrewardProgramPointsCountreward program points count of the Product
standardWarrantyLengthMonthstandardWarrantyLengthMonthstandard warranty length of the Product in months
stockLedgerValuationAmountstockLedgerValuationAmountstock ledger valuation amount of the Product
typetypetype of Product
validForPeriodCountvalidForPeriodCountvalid for period count of the Product
validFromDatevalidFromDatevalid from date of the Product
validToDatevalidToDatevalid to date of the Product
versionNumberversionNumberversion number of the Product
productCategory.idproductCategory.idunique Id of the Product Category
productCategory.nameproductCategory.namename of the Product Category
productCategory.activeFromDateproductCategory.activeFromDateactiveFromDate of a Product Category
productCategory.activeToDateproductCategory.activeToDateactiveToDate of the Product Category
productCatalog.idproductCatalog.idunique Id of the Product Catalog
productCatalog.nameproductCatalog.namename of the Product Catalog
productCatalog.activeFromDateproductCatalog.activeFromDateactiveFromDate of a Product Catalog
productCatalog.activeToDateproductCatalog.activeToDateactiveToDate of the Product Catalog
priceBookEntry.ididunique Id of the PriceBookEntry
priceBookEntry.isActiveisActivestatus of the PriceBookEntry
priceBookEntry.minRequiredQuantityminRequiredQuantityminimum required quantity for the product
priceBookEntry.minRequiredOrderValueminRequiredOrderValueminimum required order value for the product
priceBookEntry.maxRequiredOrderValuemaxRequiredOrderValuemaximum required order value for the product
priceBookEntry.servicePeriodCountservicePeriodCountservice period count for the product
priceBookEntry.unitListPriceunitListPriceprice of the product within the priceBookEntry
priceBookEntry.useStandardPriceuseStandardPriceWhether the price book entry inherits its price from the standard price book
auditInfo.createdBycreatedByIdentifies the system or user which created the entry
auditInfo.updatedByUpdatedByIdentifies the system or user which last updated the entry
auditInfo.createdDatecreatedDateIdentifies the created Time stamp of this entry
auditInfo.updatedDateUpdatedDateIdentifies the updated Time stamp of this entry
externalIds.idexternalId.idIdentifies the id for externalId
externalIds.externalIdexternalId.externalIdIdentifies the externalId for the ExternalId type
externalIds.externalIdTypeexternalId.externalIdTypeIdentifies the externalID type
externalIds.statusexternalId.statusWhether the External Id status is Valid

(back to top)

products-get-payload

Products select Mapping for PIM System

Source: ./src/main/resources/dwl/products-get-payload.dwl

Mapping Tables

Maps CIM Product to JSON which is used by stored procedure - sp_Products_Upsert

JSON used by the stored procedureCIMDescription
allowCustomerReturnallowCustomerReturnflag to allow customer to return a Product
allowPartialRefundallowPartialRefundflag to allow partial refund for a Product
brandbrandbrand grade of a Product
brandGradebrandGradebrand grade of a Product
canUseQuantitySchedulecanUseQuantityScheduleflag for quantity schedule
canUseRevenueSchedulecanUseRevenueScheduleflag for revenue schedule
descriptiondescriptiondescription of the Product
displayUrldisplayUrldisplay URL of the Product
disposalTypedisposalTypedisposal type of the Product
externalSourceRecordexternalSourceRecordexternal source record of the Product
glAccountCodeglAccountCodeGL Account Code of the Product
ididunique Id of the Product
isAutoProvisionableisAutoProvisionableflag for auto provisioning
isBackOrderedisBackOrderedflag for back ordered Product
isCouponRedemptionAllowedisCouponRedemptionAllowedflag to allow redemption of coupon
isCustomerDiscountAllowedisCustomerDiscountAllowedflag to allow customer discount on the Product
isDynamicBundleisDynamicBundleflag to highlight if a Product is part of a dynamic bundle
isFoodstampPaymentAllowedisFoodstampPaymentAllowedflag to allow food stamp payment
isInstallableisInstallableflag to install a Product
isIntellectualPropertyProtectedisIntellectualPropertyProtectedflag to protect the Product as intellectual property
isManualPriceEntryRequiredisManualPriceEntryRequiredflag to enter the price of Product manually
isMultipleCouponsAllowedisMultipleCouponsAllowedflag to allow multiple coupons on the Product
isPartnerDiscountAllowedisPartnerDiscountAllowedflag to allow partner discounts
isPreOrderableisPreOrderableflag to preorder the Product
isQualityVerificationRequiredisQualityVerificationRequiredflag to mandate verification of quality of the Product
isQuantityEntryRequiredisQuantityEntryRequiredflag to mandate entry of quantity
isRainCheckAllowedisRainCheckAllowedflag to allow rain check
isReturnableisReturnableflag to allow returning of Product
isSellableisSellableflag allow a Product to be sold
isSellableIndependentlyisSellableIndependentlyflag to allow a Product to be sold independently
isSellableWithoutPriceisSellableWithoutPriceflag to allow a Product to be sold independently
isSerializedisSerializedflag to serialize a Product
isWeightEntryRequiredisWeightEntryRequiredflag to enter weight of the Product
isWorkerDiscountAllowedisWorkerDiscountAllowedflag to allow discount for workers
longDescriptionlongDescriptionlong description of the Product
lotIdentitylotIdentitylot to identify the Product
manufacturerNamemanufacturerNamemanufacturer name of the Product
masterProductmasterProductmaster Product of the Product
maximumOrderQuantityCountmaximumOrderQuantityCountmax. quantity that can be ordered of that Product
minimumAdvertisementAmountminimumAdvertisementAmountmin. amount of advertisement of the Product
minimumAdvertisementAmountStartDateminimumAdvertisementAmountStartDatemin. amount to start advertisement of the Product
minimumOrderQuantityCountminimumOrderQuantityCountmin. amount of advertisement of the Product
modelNumbermodelNumbermodel number of the Product
modelYearmodelYearmodel year of the Product
mSRPAmountmSRPAmountMSRP amount of the Product
namenamename of the Product
priceChargeTypepriceChargeTypeprice change type of the Product
primaryProductCategoryprimaryProductCategoryprimary category of the Product
primarySalesChannelprimarySalesChannelprimary sales channel for the Product
productSKUproductSKUSKU of the Product
productStatusproductStatusstatus of the Product
quantityInstallmentCountquantityInstallmentCountquantity installment count of the Product
quantityInstallmentPeriodquantityInstallmentPeriodquantity installment period of the Product
quantityScheduleTypequantityScheduleTypequantity schedule type of the Product
requiredDepositAmountrequiredDepositAmountrequested deposit amount for the Product
requiredDepositPercentagerequiredDepositPercentagerequested deposit percentage for the Product
requiresInvididualUnitPricingrequiresInvididualUnitPricingflag to highlight that the Product requires individual unit pricing
revenueInstallmentCountrevenueInstallmentCountrevenue installment count of the Product
revenueInstallmentPeriodrevenueInstallmentPeriodrevenue installment period of the Product
revenueScheduleTyperevenueScheduleTyperevenue schedule type of the Product
rewardProgramPointsCountrewardProgramPointsCountreward program points count of the Product
standardWarrantyLengthMonthstandardWarrantyLengthMonthstandard warranty length of the Product in months
stockLedgerValuationAmountstockLedgerValuationAmountstock ledger valuation amount of the Product
typetypetype of Product
validForPeriodCountvalidForPeriodCountvalid for period count of the Product
validFromDatevalidFromDatevalid from date of the Product
validToDatevalidToDatevalid to date of the Product
versionNumberversionNumberversion number of the Product
productCategory.idproductCategory.idunique Id of the Product Category
productCategory.nameproductCategory.namename of the Product Category
productCategory.activeFromDateproductCategory.activeFromDateactiveFromDate of a Product Category
productCategory.activeToDateproductCategory.activeToDateactiveToDate of the Product Category
productCatalog.idproductCatalog.idunique Id of the Product Catalog
productCatalog.nameproductCatalog.namename of the Product Catalog
productCatalog.activeFromDateproductCatalog.activeFromDateactiveFromDate of a Product Catalog
productCatalog.activeToDateproductCatalog.activeToDateactiveToDate of the Product Catalog
priceBookEntry.ididunique Id of the PriceBookEntry
priceBookEntry.isActiveisActivestatus of the PriceBookEntry
priceBookEntry.minRequiredQuantityminRequiredQuantityminimum required quantity for the product
priceBookEntry.minRequiredOrderValueminRequiredOrderValueminimum required order value for the product
priceBookEntry.maxRequiredOrderValuemaxRequiredOrderValuemaximum required order value for the product
priceBookEntry.servicePeriodCountservicePeriodCountservice period count for the product
priceBookEntry.unitListPriceunitListPriceprice of the product within the priceBookEntry
priceBookEntry.useStandardPriceuseStandardPriceWhether the price book entry inherits its price from the standard price book
auditInfo.createdBycreatedByIdentifies the system or user which created the entry
auditInfo.updatedByUpdatedByIdentifies the system or user which last updated the entry
auditInfo.createdDatecreatedDateIdentifies the created Time stamp of this entry
auditInfo.updatedDateUpdatedDateIdentifies the updated Time stamp of this entry
externalIds.idexternalId.idIdentifies the id for externalId
externalIds.externalIdexternalId.externalIdIdentifies the externalId for the ExternalId type
externalIds.externalIdTypeexternalId.externalIdTypeIdentifies the externalID type
externalIds.statusexternalId.statusWhether the External Id status is Valid

(back to top)

products-patchbyid-payload

Products Upsert Mapping for PIM System

Source: ./src/main/resources/dwl/products-patchbyid-payload.dwl

Mapping Tables

Maps CIM Product to JSON which is used by stored procedure - sp_ExternalIds_Create

JSON used by the stored procedureCIMDescription
idexternalIds.idThe id of the entry in MDM system
externalIdexternalIds.externalIdA unique identifier assigned to the individual in another system
externalIdTypeexternalIds.externalIdTypeIdentifies the system that owns or otherwise recognizes this unique identifier
statusexternalIds.statusIndicates whether this identifier is currently valid or not
statusLastChangedDateexternalIds.statusLastChangedDateDate and time of the last change in status
createdByapplication name from propertiesIdentifies the system or user which created the entry
updatedByapplication name from propertiesIdentifies the system or user which last updated the entry
productIdidunique id of the product

(back to top)

products-upsert-pricebooks-payload

PriceBookEntry Upsert Mapping for PIM System

Source: ./src/main/resources/dwl/products-upsert-pricebooks-payload.dwl

Mapping Tables

Maps CIM PriceBookEntry to JSON which is used by stored procedure - sp_PriceBookEntry_upsert

JSON used by the stored procedureCIMDescription
idpriceBookEntry.idunique Id of the PriceBookEntry
isActivepriceBookEntry.isActivestatus of the PriceBookEntry
minRequiredQuantitypriceBookEntry.minRequiredQuantityminimum required quantity for the product
minRequiredOrderValuepriceBookEntry.minRequiredOrderValueminimum required order value for the product
maxRequiredOrderValuepriceBookEntry.maxRequiredOrderValuemaximum required order value for the product
productIdidunique Id of the Product
servicePeriodCountpriceBookEntry.servicePeriodCountservice period count for the product
unitListPricepriceBookEntry.unitListPriceprice of the product within the priceBookEntry
useStandardPricepriceBookEntry.useStandardPriceWhether the price book entry inherits its price from the standard price book
createdByapplication name from propertiesIdentifies the system or user which created the entry
updatedByapplication name from propertiesIdentifies the system or user which last updated the entry

(back to top)

products-upsert-productcategorycatalog-payload

Product Category and Product Catalog - Upsert Mapping for PIM System

Source: ./src/main/resources/dwl/products-upsert-productcategorycatalog-payload.dwl

Mapping Tables

Maps CIM Product Category and Catalog to JSON which is used by stored procedure - sp_ProductCategoryCatalog_upsert

JSON used by the stored procedureCIMDescription
idproductCategory.idunique Id of the Product Category
nameproductCategory.namename of the Product Category
activeFromDateproductCategory.activeFromDateactiveFromDate of a Product Category
activeToDateproductCategory.activeToDateactiveToDate of the Product Category
createdByapplication name from propertiesIdentifies the system or user which created the entry
updatedByapplication name from propertiesIdentifies the system or user which last updated the entry
productCatalog.idproductCatalog.idunique Id of the Product Catalog
productCatalog.nameproductCatalog.namename of the Product Catalog
productCatalog.activeFromDateproductCatalog.activeFromDateactiveFromDate of a Product Catalog
productCatalog.activeToDateproductCatalog.activeToDateactiveToDate of the Product Catalog
createdByapplication name from propertiesIdentifies the system or user which created the entry
updatedByapplication name from propertiesIdentifies the system or user which last updated the entry
productIdidunique Id of the Product

(back to top)

products-upsert-products-payload

Products Upsert Mapping for PIM System

Source: ./src/main/resources/dwl/products-upsert-products-payload.dwl

Mapping Tables

Maps CIM Product to JSON which is used by stored procedure - sp_Products_Upsert

JSON used by the stored procedureCIMDescription
allowCustomerReturnallowCustomerReturnflag to allow customer to return a Product
allowPartialRefundallowPartialRefundflag to allow partial refund for a Product
brandbrandbrand grade of a Product
brandGradebrandGradebrand grade of a Product
canUseQuantitySchedulecanUseQuantityScheduleflag for quantity schedule
canUseRevenueSchedulecanUseRevenueScheduleflag for revenue schedule
descriptiondescriptiondescription of the Product
displayUrldisplayUrldisplay URL of the Product
disposalTypedisposalTypedisposal type of the Product
externalSourceRecordexternalSourceRecordexternal source record of the Product
glAccountCodeglAccountCodeGL Account Code of the Product
ididunique Id of the Product
isAutoProvisionableisAutoProvisionableflag for auto provisioning
isBackOrderedisBackOrderedflag for back ordered Product
isCouponRedemptionAllowedisCouponRedemptionAllowedflag to allow redemption of coupon
isCustomerDiscountAllowedisCustomerDiscountAllowedflag to allow customer discount on the Product
isDynamicBundleisDynamicBundleflag to highlight if a Product is part of a dynamic bundle
isFoodstampPaymentAllowedisFoodstampPaymentAllowedflag to allow food stamp payment
isInstallableisInstallableflag to install a Product
isIntellectualPropertyProtectedisIntellectualPropertyProtectedflag to protect the Product as intellectual property
isManualPriceEntryRequiredisManualPriceEntryRequiredflag to enter the price of Product manually
isMultipleCouponsAllowedisMultipleCouponsAllowedflag to allow multiple coupons on the Product
isPartnerDiscountAllowedisPartnerDiscountAllowedflag to allow partner discounts
isPreOrderableisPreOrderableflag to preorder the Product
isQualityVerificationRequiredisQualityVerificationRequiredflag to mandate verification of quality of the Product
isQuantityEntryRequiredisQuantityEntryRequiredflag to mandate entry of quantity
isRainCheckAllowedisRainCheckAllowedflag to allow rain check
isReturnableisReturnableflag to allow returning of Product
isSellableisSellableflag allow a Product to be sold
isSellableIndependentlyisSellableIndependentlyflag to allow a Product to be sold independently
isSellableWithoutPriceisSellableWithoutPriceflag to allow a Product to be sold independently
isSerializedisSerializedflag to serialize a Product
isWeightEntryRequiredisWeightEntryRequiredflag to enter weight of the Product
isWorkerDiscountAllowedisWorkerDiscountAllowedflag to allow discount for workers
longDescriptionlongDescriptionlong description of the Product
lotIdentitylotIdentitylot to identify the Product
manufacturerNamemanufacturerNamemanufacturer name of the Product
masterProductmasterProductmaster Product of the Product
maximumOrderQuantityCountmaximumOrderQuantityCountmax. quantity that can be ordered of that Product
minimumAdvertisementAmountminimumAdvertisementAmountmin. amount of advertisement of the Product
minimumAdvertisementAmountStartDateminimumAdvertisementAmountStartDatemin. amount to start advertisement of the Product
minimumOrderQuantityCountminimumOrderQuantityCountmin. amount of advertisement of the Product
modelNumbermodelNumbermodel number of the Product
modelYearmodelYearmodel year of the Product
mSRPAmountmSRPAmountMSRP amount of the Product
namenamename of the Product
priceChargeTypepriceChargeTypeprice change type of the Product
primaryProductCategoryprimaryProductCategoryprimary category of the Product
primarySalesChannelprimarySalesChannelprimary sales channel for the Product
productSKUproductSKUSKU of the Product
productStatusproductStatusstatus of the Product
quantityInstallmentCountquantityInstallmentCountquantity installment count of the Product
quantityInstallmentPeriodquantityInstallmentPeriodquantity installment period of the Product
quantityScheduleTypequantityScheduleTypequantity schedule type of the Product
requiredDepositAmountrequiredDepositAmountrequested deposit amount for the Product
requiredDepositPercentagerequiredDepositPercentagerequested deposit percentage for the Product
requiresInvididualUnitPricingrequiresInvididualUnitPricingflag to highlight that the Product requires individual unit pricing
revenueInstallmentCountrevenueInstallmentCountrevenue installment count of the Product
revenueInstallmentPeriodrevenueInstallmentPeriodrevenue installment period of the Product
revenueScheduleTyperevenueScheduleTyperevenue schedule type of the Product
rewardProgramPointsCountrewardProgramPointsCountreward program points count of the Product
standardWarrantyLengthMonthstandardWarrantyLengthMonthstandard warranty length of the Product in months
stockLedgerValuationAmountstockLedgerValuationAmountstock ledger valuation amount of the Product
typetypetype of Product
validForPeriodCountvalidForPeriodCountvalid for period count of the Product
validFromDatevalidFromDatevalid from date of the Product
validToDatevalidToDatevalid to date of the Product
versionNumberversionNumberversion number of the Product
externalIdsvars.customerExternalIdsThe externalIds of the product that are stored in MDM
createdByapplication name from propertiesIdentifies the system or user which created the entry
updatedByapplication name from propertiesIdentifies the system or user which last updated the entry

(back to top)


Reviews

TypeTemplate
OrganizationMuleSoft
Published by
MuleSoft Solutions
Published onNov 7, 2022
Asset overview

Asset versions for 2.6.x

Asset versions
VersionActions
2.6.0